<!DOCTYPE html>
<html>

<head>
  <title>How to Create Quarkus Documentation</title>
  <script id="adobe_dtm" src="https://www.redhat.com/dtm.js" type="text/javascript"></script>
  <script src="/assets/javascript/highlight.pack.js" type="text/javascript"></script>
  <META HTTP-EQUIV='Content-Security-Policy' CONTENT="default-src 'none'; script-src 'self' 'unsafe-eval' 'sha256-ANpuoVzuSex6VhqpYgsG25OHWVA1I+F6aGU04LoI+5s=' 'sha256-ipy9P/3rZZW06mTLAR0EnXvxSNcnfSDPLDuh3kzbB1w=' js.bizographics.com https://www.redhat.com assets.adobedtm.com jsonip.com https://ajax.googleapis.com https://www.googletagmanager.com https://www.google-analytics.com https://use.fontawesome.com; style-src 'self' https://fonts.googleapis.com https://use.fontawesome.com; img-src 'self' *; media-src 'self' ; frame-src https://www.googletagmanager.com https://www.youtube.com; frame-ancestors 'none'; base-uri 'none'; object-src 'none'; form-action 'none'; font-src 'self' https://use.fontawesome.com https://fonts.gstatic.com;">
  <META HTTP-EQUIV='X-Frame-Options' CONTENT="DENY">
  <META HTTP-EQUIV='X-XSS-Protection' CONTENT="1; mode=block">
  <META HTTP-EQUIV='X-Content-Type-Options' CONTENT="nosniff">
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="description" content="Quarkus: Supersonic Subatomic Java">
  <meta name="twitter:card" content="summary_large_image">
  <meta name="twitter:site" content="@QuarkusIO"> 
  <meta name="twitter:creator" content="@QuarkusIO">
  <meta property="og:url" content="https://quarkus.io/guides/readme" />
  <meta property="og:title" content="How to Create Quarkus Documentation" />
  <meta property="og:description" content="Quarkus: Supersonic Subatomic Java" />
  <meta property="og:image" content="/assets/images/quarkus_card.png" />
  <link rel="canonical" href="https://quarkus.io/guides/readme">
  <link rel="shortcut icon" type="image/png" href="/favicon.ico" >
  <link rel="stylesheet" href="https://quarkus.io/guides/stylesheet/config.css" />
  <link rel="stylesheet" href="/assets/css/main.css" />
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
  <link rel="alternate" type="application/rss+xml"  href="https://quarkus.io/feed.xml" title="Quarkus">
  <script src="https://quarkus.io/assets/javascript/goan.js" type="text/javascript"></script>
  <script src="https://quarkus.io/assets/javascript/hl.js" type="text/javascript"></script>
</head>

<body class="guides">
  <!-- Google Tag Manager (noscript) -->
  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NJWS5L"
  height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
  <!-- End Google Tag Manager (noscript) -->

  <div class="nav-wrapper">
  <div class="grid-wrapper">
    <div class="width-12-12">
      <input type="checkbox" id="checkbox" />
      <nav id="main-nav" class="main-nav">
  <div class="container">
    <div class="logo-wrapper">
      
        <a href="/"><img src="/assets/images/quarkus_logo_horizontal_rgb_600px_reverse.png" class="project-logo" title="Quarkus"></a>
      
    </div>
    <label class="nav-toggle" for="checkbox">
      <i class="fa fa-bars"></i>
    </label>
    <div id="menu" class="menu">
      <span>
        <a href="/get-started/" class="">Get Started</a>
      </span>
      <span>
        <a href="/guides/" class="active">Guides</a>
      </span>
      <span>
        <a href="/community/" class="">Community</a>
      </span>
      <span>
        <a href="/support/" class="">Support</a>
      </span>
      <span>
        <a href="/blog/" class="">Blog</a>
      </span>
      <span>
        <a href="https://code.quarkus.io" class="button-cta secondary white">Start Coding</a>
      </span>
    </div>
  </div>
      </nav>
    </div>
  </div>
</div>

  <div class="content">
    <div class="guide">
  <div class="width-12-12">
    <h1 class="text-caps">How to Create Quarkus Documentation</h1>
    <div class="hide-mobile toc"><ul class="sectlevel1">
<li><a href="#references">References</a></li>
<li><a href="#variables-for-use-in-documents">Variables for Use in Documents</a></li>
</ul></div>
    <div>
      <div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This guide describes the asciidoc format and conventions that Quarkus has adopted.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="references"><a class="anchor" href="#references"></a>References</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following links provide background on the general conventions and Asciidoc syntax.</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://redhat-documentation.github.io/asciidoc-markup-conventions/">AsciiDoc Mark-up Quick Reference for Documentation</a></p>
</li>
<li>
<p><a href="http://asciidoctor.org/docs/user-manual/">Asciidoctor User Manual</a></p>
</li>
<li>
<p><a href="http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/">AsciiDoc Syntax Quick Reference</a></p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="variables-for-use-in-documents"><a class="anchor" href="#variables-for-use-in-documents"></a>Variables for Use in Documents</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following variables externalize key information that can change over time, and so references
to such information should be done by using the variable inside of {} curly brackets. The
complete list of externalized variables for use is given in the following table:</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. Variables</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Property Name</th>
<th class="tableblock halign-left valign-top">Value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-version}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1.7.0.Final</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The current version of the project.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-home-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://quarkus.io" class="bare">https://quarkus.io</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The location of the project home page.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-site-getting-started}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/get-started</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The location of the getting started page.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-org-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio" class="bare">https://github.com/quarkusio</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The location of the project github organization.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-base-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus" class="bare">https://github.com/quarkusio/quarkus</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus GitHub URL common base prefix.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-clone-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus.git" class="bare">https://github.com/quarkusio/quarkus.git</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL for git clone referenced by the documentation.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-archive-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus/archive/master.zip" class="bare">https://github.com/quarkusio/quarkus/archive/master.zip</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL to master source archive.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-blob-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-blob-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL to master blob source tree; used for referencing source files.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-tree-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus/tree/master" class="bare">https://github.com/quarkusio/quarkus/tree/master</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL to master source tree root; used for referencing directories.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-issues-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus/issues" class="bare">https://github.com/quarkusio/quarkus/issues</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL to the issues page.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-images-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-images/tree" class="bare">https://github.com/quarkusio/quarkus-images/tree</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quarkus URL to set of container images delivered for Quarkus.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-chat-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://quarkusio.zulipchat.com" class="bare">https://quarkusio.zulipchat.com</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">URL of our chat.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-mailing-list-subscription-email}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="mailto:quarkus-dev+subscribe@googlegroups.com">quarkus-dev+subscribe@googlegroups.com</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Email used to subscribe to our mailing list.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quarkus-mailing-list-index}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://groups.google.com/d/forum/quarkus-dev" class="bare">https://groups.google.com/d/forum/quarkus-dev</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Mailing list index page.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quickstarts-base-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-quickstarts" class="bare">https://github.com/quarkusio/quarkus-quickstarts</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quickstarts URL common base prefix.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quickstarts-clone-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-quickstarts.git" class="bare">https://github.com/quarkusio/quarkus-quickstarts.git</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quickstarts URL for git clone referenced by the documentation.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quickstarts-archive-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-quickstarts/archive/master.zip" class="bare">https://github.com/quarkusio/quarkus-quickstarts/archive/master.zip</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quickstarts URL to master source archive.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quickstarts-blob-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-quickstarts/blob/master" class="bare">https://github.com/quarkusio/quarkus-quickstarts/blob/master</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quickstarts URL to master blob source tree; used for referencing source files.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{quickstarts-tree-url}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code><a href="https://github.com/quarkusio/quarkus-quickstarts/tree/master" class="bare">https://github.com/quarkusio/quarkus-quickstarts/tree/master</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quickstarts URL to master source tree root; used for referencing directories.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{graalvm-version}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>20.1.0</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Recommended GraalVM version to use.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>{graalvm-flavor}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>20.1.0-java11</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The full flavor of GraaVM to use e.g. <code>19.3.1-java11</code>.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
    </div>
  </div>
</div>

  </div>

  <div class="content project-footer">
  <div class="footer-section">
    <div class="logo-wrapper">
      <a href="/"><img src="/assets/images/quarkus_logo_horizontal_rgb_reverse.svg" class="project-logo" title="Quarkus"></a>
    </div>
  </div>
  <div class="grid-wrapper">
    <p class="grid__item width-3-12">Quarkus is open. All dependencies of this project are available under the <a href='https://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache Software License 2.0</a> or compatible license.<br /><br />This website was built with <a href='https://jekyllrb.com/' target='_blank'>Jekyll</a>, is hosted on <a href='https://pages.github.com/' target='_blank'>Github Pages</a> and is completely open source. If you want to make it better, <a href='https://github.com/quarkusio/quarkusio.github.io' target='_blank'>fork the website</a> and show us what you’ve got.</p>

    
      <div class="width-1-12 project-links">
        <span>Navigation</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="/">Home</a></li>
          
            <li><a href="/guides">Guides</a></li>
          
            <li><a href="/community/#contributing">Contribute</a></li>
          
            <li><a href="/faq">FAQ</a></li>
          
            <li><a href="/get-started">Get Started</a></li>
          
        </ul>
      </div>
    
      <div class="width-1-12 project-links">
        <span>Contribute</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="https://twitter.com/quarkusio">Follow us</a></li>
          
            <li><a href="https://github.com/quarkusio">GitHub</a></li>
          
            <li><a href="/security">Security&nbsp;policy</a></li>
          
        </ul>
      </div>
    
      <div class="width-1-12 project-links">
        <span>Get Help</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="https://groups.google.com/forum/#!forum/quarkus-dev">Forums</a></li>
          
            <li><a href="https://quarkusio.zulipchat.com">Chatroom</a></li>
          
        </ul>
      </div>
    

    
      <div class="width-3-12 more-links">
        <span>Quarkus is made of community projects</span>
        <ul class="footer-links">
          
            <li><a href="https://vertx.io/" target="_blank">Eclipse Vert.x</a></li>
          
            <li><a href="https://microprofile.io" target="_blank">Eclipse MicroProfile</a></li>
          
            <li><a href="https://hibernate.org" target="_blank">Hibernate</a></li>
          
            <li><a href="https://netty.io" target="_blank">Netty</a></li>
          
            <li><a href="https://resteasy.github.io" target="_blank">RESTEasy</a></li>
          
            <li><a href="https://camel.apache.org" target="_blank">Apache Camel</a></li>
          
            <li><a href="https://code.quarkus.io/" target="_blank">And many more...</a></li>
          
        </ul>
      </div>
    
  </div>
</div>
  <div class="content redhat-footer">
  <div class="grid-wrapper">
    <span class="licence">
      <i class="fab fa-creative-commons"></i><i class="fab fa-creative-commons-by"></i> <a href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC by 3.0</a> | <a href="https://www.redhat.com/en/about/privacy-policy">Privacy Policy</a>
    </span>
    <span class="redhat">
      Sponsored by
    </span>
    <span class="redhat-logo">
      <a href="https://www.redhat.com/" target="_blank"><img src="/assets/images/redhat_reversed.svg"></a>
    </span>
  </div>
</div>


  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js" integrity="sha384-8gBf6Y4YYq7Jx97PIqmTwLPin4hxIzQw5aDmUg/DDhul9fFpbbLcLh3nTIIDJKhx" crossorigin="anonymous"></script>
  <script type="text/javascript" src="/assets/javascript/mobile-nav.js"></script>
  <script type="text/javascript" src="/assets/javascript/scroll-down.js"></script>
  <script src="/assets/javascript/satellite.js" type="text/javascript"></script>
  <script src="https://quarkus.io/guides/javascript/config.js" type="text/javascript"></script>
  <script src="/assets/javascript/search-filter.js" type="text/javascript"></script>
  <script src="/assets/javascript/back-to-top.js" type="text/javascript"></script>
</body>

</html>
